.TH std::log,std::logf,std::logl 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::log,std::logf,std::logl \- std::log,std::logf,std::logl

.SH Synopsis
   Defined in header <cmath>
   float       log ( float num );

   double      log ( double num );                            (until C++23)

   long double log ( long double num );
   /* floating-point-type */                                  (since C++23)
               log ( /* floating-point-type */ num );         (constexpr since C++26)
   float       logf( float num );                     \fB(1)\fP \fB(2)\fP \fI(since C++11)\fP
                                                              (constexpr since C++26)
   long double logl( long double num );                   \fB(3)\fP \fI(since C++11)\fP
                                                              (constexpr since C++26)
   Additional overloads \fI(since C++11)\fP
   Defined in header <cmath>
   template< class Integer >                              (A) (constexpr since C++26)
   double      log ( Integer num );

   1-3) Computes the natural (base e) logarithm of num.
   The library provides overloads of std::log for all cv-unqualified floating-point
   types as the type of the parameter.
   (since C++23)

   A) Additional overloads are provided for all integer types, which are  \fI(since C++11)\fP
   treated as double.

.SH Parameters

   num - floating-point or integer value

.SH Return value

   If no errors occur, the natural (base-e) logarithm of num (ln(num) or log
   e(num)) is returned.

   If a domain error occurs, an implementation-defined value is returned (NaN where
   supported).

   If a pole error occurs, -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL is returned.

.SH Error handling

   Errors are reported as specified in math_errhandling.

   Domain error occurs if num is less than zero.

   Pole error may occur if num is zero.

   If the implementation supports IEEE floating-point arithmetic (IEC 60559),

     * If the argument is ±0, -∞ is returned and FE_DIVBYZERO is raised.
     * If the argument is 1, +0 is returned.
     * If the argument is negative, NaN is returned and FE_INVALID is raised.
     * If the argument is +∞, +∞ is returned.
     * If the argument is NaN, NaN is returned.

.SH Notes

   The additional overloads are not required to be provided exactly as (A). They only
   need to be sufficient to ensure that for their argument num of integer type,
   std::log(num) has the same effect as std::log(static_cast<double>(num)).

.SH Example


// Run this code

 #include <cerrno>
 #include <cfenv>
 #include <cmath>
 #include <cstring>
 #include <iostream>
 // #pragma STDC FENV_ACCESS ON

 int main()
 {
     std::cout << "log(1) = " << std::log(1) << '\\n'
               << "base-5 logarithm of 125 = " << std::log(125) / std::log(5) << '\\n';

     // special values
     std::cout << "log(1) = " << std::log(1) << '\\n'
               << "log(+Inf) = " << std::log(INFINITY) << '\\n';

     // error handling
     errno = 0;
     std::feclearexcept(FE_ALL_EXCEPT);

     std::cout << "log(0) = " << std::log(0) << '\\n';

     if (errno == ERANGE)
         std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\\n';
     if (std::fetestexcept(FE_DIVBYZERO))
         std::cout << "    FE_DIVBYZERO raised\\n";
 }

.SH Possible output:

 log\fB(1)\fP = 0
 base-5 logarithm of 125 = 3
 log\fB(1)\fP = 0
 log(+Inf) = inf
 log\fB(0)\fP = -inf
     errno == ERANGE: Numerical result out of range
     FE_DIVBYZERO raised

.SH See also

   log10
   log10f             computes common (base 10) logarithm
   log10l             (\\({\\small\\log_{10}{x}}\\)log[10](x))
   \fI(C++11)\fP            \fI(function)\fP
   \fI(C++11)\fP
   log2
   log2f              base 2 logarithm of the given number
   log2l              (\\({\\small\\log_{2}{x}}\\)log[2](x))
   \fI(C++11)\fP            \fI(function)\fP
   \fI(C++11)\fP
   \fI(C++11)\fP
   log1p
   log1pf             natural logarithm (to base e) of 1 plus the given number
   log1pl             (\\({\\small\\ln{(1+x)}}\\)ln(1+x))
   \fI(C++11)\fP            \fI(function)\fP
   \fI(C++11)\fP
   \fI(C++11)\fP
   exp
   expf               returns e raised to the given power (\\({\\small e^x}\\)e^x)
   expl               \fI(function)\fP
   \fI(C++11)\fP
   \fI(C++11)\fP
                      complex natural logarithm with the branch cuts along the negative
   log(std::complex)  real axis
                      \fI(function template)\fP
   log(std::valarray) applies the function std::log to each element of valarray
                      \fI(function template)\fP
   C documentation for
   log
